Laravel 中的模型事件与 Observer

模型事件

在 Laravel 的世界中,你对 Eloquent 大多数操作都会或多或少的触发一些模型事件,今天就来看一下模型事件的使用。

Laravel 事先已经定义好了 10 个模型事件以供我们使用,它们分别是：

creating, created , updating, updated, saving, saved, deleting, deleted, restoring, restored。

事件名称都很浅显易懂,相信如果你是用脑子写代码的话都应该可以看明白,如果不明白的话可以左转百度。

不过你可能对 updating, updated, saving, saved 这四个事件有所疑惑,所以我们来详细分析一下。

打开 Illuminate\Database\Eloquent\Model ,找到位于 517 行的 save 方法

笔者使用的是 Laravel 5.5 最新版本,如果你使用的是其他版本,请自行在官方文档 版本差异 中对比你的版本

public function save(array $options = [])
{
    $query = $this->newQueryWithoutScopes();

    if ($this->fireModelEvent('saving') === false) {
        return false;
    }

    if ($this->exists) {
        $saved = $this->isDirty() ?
                    $this->performUpdate($query) : true;
    }

    else {
        $saved = $this->performInsert($query);

        if (! $this->getConnectionName() &&
            $connection = $query->getConnection()) {
            $this->setConnection($connection->getName());
        }
    }

    if ($saved) {
        $this->finishSave($options);
    }

    return $saved;
}

可以看到首先触发的是 saving：

$this->fireModelEvent('saving')

接着会判断此 model 是不是新创建的。

如果是新创建的,那么则会进行 insert 操作,由于本例是分析修改操作,所以这里直接略过。

如果不是新创建的,那么会调用 isDirty 方法判断此 model 是否进行了修改。

如果进行了修改,那么会调用 performUpdate 方法进行更新操作,如果没有进行修改,则直接返回 true。

让我们点开 performUpdate 方法。

protected function performUpdate(Builder $query)
{
    if ($this->fireModelEvent('updating') === false) {
        return false;
    }

    if ($this->usesTimestamps()) {
        $this->updateTimestamps();
    }

    $dirty = $this->getDirty();

    if (count($dirty) > 0) {
        $this->setKeysForSaveQuery($query)->update($dirty);

        $this->fireModelEvent('updated', false);

        $this->syncChanges();
    }

    return true;
}

可以看到这里会触发 updating：

$this->fireModelEvent('updating')

如果返回的不是 false ,那么会接着往下走,判断一下此模型是否使用了 Timestamp,如果使用了,那么则先更新自身的 Timestamp：

if ($this->usesTimestamps()) {
    $this->updateTimestamps();
}

接着调用 getDirty,顾名思义,大概可以知道这个方法是获取自身的脏值,让我们点开看一下:

public function getDirty()
{
    $dirty = [];

    foreach ($this->getAttributes() as $key => $value) {
        if (! $this->originalIsEquivalent($key, $value)) {
            $dirty[$key] = $value;
        }
    }

    return $dirty;
}

意料之中,此方法内会返回自身被修改后的脏值,如果你打印过 Laravel 的 Model 实例,那么相信你会看到实例中有 original 和 attributes 两个数组。

其中 original 保存的是最初始的实例属性,无法被外部直接修改。

attributes 数组则是可以被自有修改，此方法即是由判断两个数组的差异而返回脏值，由于时间原因，这里不做过多详解，有机会单开一个文章慢慢讲。

继续往下走，可以看到这里会判断一下是否有脏值：

if (count($dirty) > 0)

只有在存在脏值的情况下才会进入 if 内部，执行 update 操作，继而触发 updated 事件

在 update 结束后会执行一下 syncChanges 同步一下自身的数据

OK, performUpdate 方法解析完毕，让我们回到 save 方法，接着往下看，可以看到 Laravel 最后做了一个判断:

if ($saved) {
    $this->finishSave($options);
}

只有在 update 成功的情况下，才会触发 finishSave() 方法，此方法会接收一个参数 $options,即是修改的属性。

让我们点开此方法：

protected function finishSave(array $options)
{
    $this->fireModelEvent('saved', false);

    if ($this->isDirty() && ($options['touch'] ?? true)) {
        $this->touchOwners();
    }

    $this->syncOriginal();
}

可以看到在此方法内会触发 saved 事件

分析完毕，大概可以做一个总结了。

当模型已存在，不是新建的时候，依次触发的顺序是:

saving -> updating -> updated -> saved

当模型不存在，需要新增的时候，依次触发的顺序则是

saving -> creating -> created -> saved

那么 saving,saved 和 updating,updated 到底有什么区别呢？

上面已经讲过，Laravel 的 Eloquent 会维护实例的两个数组，分别是 original 和 attributes。

只有在 saved 事件触发之后，Laravel 才会对两个数组执行 syncOriginal 操作，这样就很好理解了。

updating 和 updated 会在数据库中的真值修改前后触发。

saving 和 saved 则会在 Eloquent 实例的 original 数组真值更改前后触发。

这样我们就可以根据业务场景来选择更合适的触发事件了~

Observer (观察者)

如果你想在一个模型中监听多个事件，那么你可以把它写成一个类，类中的方法名称即是你想要监听的事件名称

class UserObserver
{

    /**
     * 监听数据即将创建的事件。
     *
     * @param  User $user
     * @return void
     */
    public function creating(User $user)
    {

    }

    /**
     * 监听数据创建后的事件。
     *
     * @param  User $user
     * @return void
     */
    public function created(User $user)
    {

    }

    /**
     * 监听数据即将更新的事件。
     *
     * @param  User $user
     * @return void
     */
    public function updating(User $user)
    {

    }

    /**
     * 监听数据更新后的事件。
     *
     * @param  User $user
     * @return void
     */
    public function updated(User $user)
    {

    }

    /**
     * 监听数据即将保存的事件。
     *
     * @param  User $user
     * @return void
     */
    public function saving(User $user)
    {

    }

    /**
     * 监听数据保存后的事件。
     *
     * @param  User $user
     * @return void
     */
    public function saved(User $user)
    {

    }

    /**
     * 监听数据即将删除的事件。
     *
     * @param  User $user
     * @return void
     */
    public function deleting(User $user)
    {

    }

    /**
     * 监听数据删除后的事件。
     *
     * @param  User $user
     * @return void
     */
    public function deleted(User $user)
    {

    }

    /**
     * 监听数据即将从软删除状态恢复的事件。
     *
     * @param  User $user
     * @return void
     */
    public function restoring(User $user)
    {

    }

    /**
     * 监听数据从软删除状态恢复后的事件。
     *
     * @param  User $user
     * @return void
     */
    public function restored(User $user)
    {

    }
}

然后在 AppServiceProvider 中注册此观察者

<?php

namespace App\Providers;

use App\User;
use App\Observers\UserObserver;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 运行所有应用.
     *
     * @return void
     */
    public function boot()
    {
    
         // 为 User 模型注册观察者
        User::observe(UserObserver::class);
    }

    /**
     * 注册服务提供.
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

然后你就可以在你注册的 Observer 中观测到各种事件啦~